home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 9 / Night Owl CD-ROM (NOPV9) (Night Owl Publisher) (1993).ISO / 052a / sudsw11.zip / SUDSW.DOC < prev    next >
Text File  |  1993-02-16  |  20KB  |  458 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                            SUDSW version 1.1
  13.                            Copyright (C) 1993
  14.                                    by
  15.                             Michael C. Taylor
  16.                            All rights reserved
  17.  
  18.  
  19.  
  20.  
  21.                               Introduction
  22.  
  23.            The key to successful brewing lies in keeping good
  24.       records of each batch!  Like most, I tend to learn from my
  25.       experiences (good and bad).  My weak point has always been
  26.       in locating the scraps of paper where I invariably kept my
  27.       brewing notes.
  28.  
  29.            This was the inspiration for SUDS - the brewers
  30.       cookbook and log program.  From a simple attempt to
  31.       coordinate some recipe and log notes, SUDS turned into a
  32.       year-long project and has resulted in an extremely
  33.       comprehensive brewer's program.
  34.  
  35.            This is the second major release of SUDS for Microsoft
  36.       Windows 3.x and involved almost a total rewrite of the DOS
  37.       version.  The two versions are extremely similar and share
  38.       the same file structures.  You can move easily between both
  39.       versions and can even keep both in the same directory if you
  40.       wish!
  41.  
  42.       SUDSW includes the following features:
  43.       o    DBASE III compatible recipe and log files which can be
  44.            browsed by any utility capable of viewing DBASE III
  45.            file formats.
  46.       o    Multi-windowing editor featuring undo, full cut and
  47.            paste capability between windows, mouse support and
  48.            Windows clipboard import/export.
  49.       o    Ability to import and export standard ASCII text files
  50.            to and from the SUDS recipe database allowing recipes
  51.            to be shared with SUDS and non-SUDS brewers.
  52.       o    Ability to import and export formatted SUDS SXF-files
  53.            allowing you to share your recipes easily with other
  54.            SUDS and SUDSW users.
  55.       o    Recipe and log printing and reporting capabilities.
  56.       o    Categorization of recipes by type (ie Pale Ale, Stout
  57.            and any categories you may have defined)
  58.       o    Built-in pop-up calculator to help with calculations.
  59.       o    Built-in pop-up calendar
  60.       o    Hop-IBU spreadsheet to calculate hop IBUs for beer
  61.            batches.
  62.       o    Printing of beer labels.
  63.  
  64.       SUDSW is not, nor has it ever been free software or "Public
  65.       Domain".  SUDSW is being distributed as shareware and
  66.       continued use beyond the 30-day trial period is prohibited.
  67.  
  68.       Unlike a new recipe, SUDSW is a no-lose proposition!  You're
  69.       free to try out SUDSW for a 30 day period after which you can
  70.       pay the nominal $15 registration fee if you are satisfied.
  71.  
  72.  
  73.  
  74.  
  75.       Because SUDSW is distributed as shareware, you are strongly
  76.       encouraged to share SUDSW with other brewers.  I would ask
  77.       only that if you do use the program, you pay the
  78.       registration fee.  Shareware only works as well as it is
  79.       supported and this helps keep software prices reasonable!
  80.  
  81.       The support for SUDSW will help determine whether or not it
  82.       will continue to be released as shareware.
  83.  
  84.       Hardware requirements - This release of SUDS requires at least
  85.       2 megs of memory and Microsoft Windows release 3.0 or higher
  86.       (or OS/2 2.0).
  87.  
  88.  
  89.  
  90.  
  91.                            Installing SUDSW
  92.  
  93.       SUDSW is distributed in either a ZIP file or a self-
  94.       extracting archive file called SUDW10.EXE.  If you have
  95.       SUDW10.ZIP, you will need a utility to "UNZIP" the file
  96.       (PKUNZIP, XTGold, etc.).
  97.  
  98.       To install SUDSW do the following:
  99.  
  100.         Create a directory on your hard disk to house the SUDSW
  101.         files (named SUDS or SUDSW for example).
  102.         Copy the SUDW10.EXE or SUDW10.ZIP file into the
  103.         directory.
  104.         Change into the directory (ie CD \SUDS).
  105.         Type "SUDW10" at a DOS command line (or DOS window)
  106.         to extract SUDW10.EXE; or "unzip" SUDW10.ZIP with 
  107.         your unzip utility.
  108.  
  109.       NOTE - Previous users of DOS SUDS:  You will probably want
  110.       to install SUDSW into your current SUDS directory.  This 
  111.       will allow both versions to share the same set of files so
  112.       you can run from Windows or DOS!
  113.  
  114.       SUDSW should now be installed on your computer.  You may want
  115.       to create a group in Program Manager to add SUDSW to (See
  116.       Windows documentation for details on program manager).
  117.  
  118.       Now that SUDSW is on your system, you should type "DIR" and
  119.       see at a minimum the following files:
  120.         SUDSW.EXE      - SUDSW program file
  121.         SUDSCVT.EXE    - Conversion program to update files from 1.0
  122.         SUDSHST.DAT    - Configuration for for SUDSW
  123.         BWCC.DLL       - Needed to run SUDSW
  124.         SUDSW.HLP      - On-line Help file for SUDSW
  125.         SUDSW.DOC      - Documentation file for SUDSW
  126.         README.TXT     - Short introduction to SUDSW release
  127.         REGISTER.TXT   - SUDSW registration form
  128.         RECIPES.SXF    - "Starter" set of recipes to import into
  129.                          SUDSW.
  130.  
  131.       Once your installation is complete, run SUDSW from the
  132.       Program Manager group you set up or from File Manager.
  133.       This will put you into the multi-windowing SUDSW desktop.
  134.  
  135.       Select the "Options" menu with the mouse or arrow keys and
  136.       then select the "Import SXF file" option.  This option is
  137.       used to import recipes that have been saved in the SUDS
  138.       "SXF" file format.  The file RECIPES.SXP provided with SUDSW
  139.       contains several recipes to get you started.  Select the
  140.       "RECIPES.SXP" file from the Import list.  This will load the
  141.       SUDS database with the starter-set of recipes.
  142.  
  143.  
  144.  
  145.  
  146.                           The SUDSW environment
  147.  
  148.       If you've used the DOS version of SUDS or are familiar with
  149.       any standard Windows applications, you will quickly feel
  150.       right at home with SUDSW.  You'll find a menu along the top
  151.       of the screen with pull-down options.  Take advantage of the
  152.       help function!  This describes all of the major functions
  153.       of SUDSW.
  154.  
  155.       Whenever you are editing recipe or log information, you will
  156.       find vertical and horizontal "scroll-bars" along the free-
  157.       form editing areas.  You can page through textual
  158.       information with the standard keyboard keys, by clicking the
  159.       mouse on the scroll-bars or by dragging the scroll-bar
  160.       indicator (small box) with the mouse.
  161.  
  162.       The editor used in SUDSW is extremely easy to use and has
  163.       full editing features in the Edit menu including an "UNDO"
  164.       command that will undo changes made.  
  165.  
  166.       The right mouse button in several places is active to
  167.       provide a "shortcut" to one of the menu options.  For
  168.       example, while editing an existing recipe, pressing the
  169.       right mouse button will display a list of log entries for
  170.       the recipe (if any exist) providing a means to edit or add
  171.       new log entries for the recipe.  The right mouse button is
  172.       also active in date fields and the HOP IBU field in the log
  173.       detail screen.
  174.  
  175.       The SUDSW environment allows any number of windows to be open
  176.       at one time (limited only by the memory on your PC).  The
  177.       best way to get familiar with this is to experiment with the
  178.       program.  Open one or 10 windows!  You can switch between
  179.       windows by clicking on any exposed portion of a window, or
  180.       by selecting a window from the Windows file option.  If a 
  181.       window is not visible (ie is covered by another), use the
  182.       Cascade or Tile option from the Windows menu at the top of
  183.       the screen to rearrange the windows.
  184.  
  185.       When saving recipe information or log information, SUDSW uses
  186.       dialog boxes to enter field by field information.  Use the
  187.       tab and back tab keys to skip from field to field.  If you
  188.       use to mouse to go directly to a field, hold down the left
  189.       button and drag across the field if you intend to change it.
  190.       If you then type something, the field will change to the new
  191.  
  192.      
  193.  
  194.       information (you could also press delete to remove the old
  195.       value before typing).  If you use tab and back tab, you
  196.       won't have to worry about this.  Again, explore and have a
  197.       home-brew!
  198.  
  199.       All SUDSW screens provide on-line help available by pressing
  200.       the F1 key.  This provides context sensitive help particular
  201.       to the function you are attempting.  Use this frequently!
  202.  
  203.       The SUDSW database stores information in DBASE III compatible
  204.       files.  Information within SUDSW is organized into recipes
  205.       within beer categories and log entries for recipes.  To
  206.       enter a log entry requires that a recipe entry first exist.
  207.       Hop information can also be entered for any log entries.
  208.       You must first have a log entry before using the HOP IBU
  209.       spreadsheet.
  210.  
  211.       You can transfer text to and from different SUDSW windows (or
  212.       within the same SUDSW window) by using the commands found
  213.       under the Edit menu.  SUDSW uses the standard Windows "clipboard"
  214.       to allow you to Cut, Copy and Paste text information to and 
  215.       from windows or even other Windows applications.
  216.  
  217.       To copy text into the "clipboard", you first must mark the
  218.       block to copy.  With the mouse this is done by holding down
  219.       the left button and dragging across the desired text. Once 
  220.       the text is marked select the Cut command to MOVE the text
  221.       into the clipboard, or the Copy command to COPY the text 
  222.       into the clipboard.
  223.  
  224.       To copy text from the "clipboard", move the cursor to the
  225.       desired location for the text and select Paste from the Edit
  226.       window.  After one or two tries, this should be intuitive.
  227.  
  228.      
  229.  
  230.  
  231.                        Entering Recipes
  232.  
  233.       Recipes can be entered into SUDSW in many ways.  You can key
  234.       in a new recipe entirely from scratch.  You can open any
  235.       ASCII file (for instance a recipe downloaded from
  236.       CompuServe) and then save the recipe into the SUDS database.
  237.       You can also do combined functions such as opening a file,
  238.       selecting recipe information and copying the information
  239.       into another window (ie for Internet newsletters).
  240.  
  241.       To enter a recipe from scratch, you would select New Recipe
  242.       from the File menu of SUDSW.  This opens up a blank edit
  243.       window into which you would enter your recipe text.  When
  244.       you complete your keying, pressing F2 or selecting the Save
  245.       option would display the Recipe details screen.  Here you
  246.       enter any pertinent information about the recipe such as
  247.       starting and finishing gravities, category (Pale Ale, etc.),
  248.       method (ie Extract, Full Mash).  Selecting OK would then
  249.       save the recipe into the SUDSW database.
  250.  
  251.       To import a recipe from a file you would select the Open
  252.       File option from the File menu.  This would bring up a list
  253.       of files in the current directory.  You can select files
  254.       from other directories by clicking on any directory names
  255.       from the Open file dialog box.  Once you select a file, an
  256.       edit window will be opened showing the contents of the file.
  257.       Here you can edit or change any recipe information and then
  258.       save it back to a file or into the SUDSW database from the
  259.       File menu.
  260.  
  261.       A good source of recipes is the Internet newsletter
  262.       available by Internet Email or on CompuServe in the Beer
  263.       forum.  These newsletters often contain a wealth of
  264.       information as well as recipes.  To extract a recipe from
  265.       within a file proceed as follows:
  266.  
  267.       o Use the Open File option to open the file
  268.       o Find the recipe in the file
  269.       o Mark the recipe with the mouse or keyboard commands
  270.          (See above)
  271.       o Select the Copy command from the Edit menu at the top of
  272.         the screen.
  273.       o Select New Recipe to open another empty window.
  274.       o Select the Paste command to copy the text you previously
  275.         copied into the "Clipboard" into the new window.
  276.       o Save the recipe from the new window into the SUDS
  277.         database.
  278.  
  279.       This really is much easier than it sounds.  With a little
  280.       trial and error, you'll find that cutting and pasting is
  281.       usually the easiest way to create a new recipe since most
  282.       recipes are variations of one kind or another.
  283.  
  284.  
  285.  
  286.  
  287.       With SUDSW you can also import recipes from other SUDS users!
  288.       This is nicer than importing ASCII files since SUDS "SXF"
  289.       files already include any Recipe detail information.  From
  290.       the SUDS Options menu, you can export your database to any
  291.       "SXF" file or import any "SXF" file.
  292.  
  293.       Note - The file structures are IDENTICAL for both DOS SUDS
  294.       users and Windows SUDS users so files may be easily exchanged
  295.       and you can use either version interchangably.
  296.  
  297.       The import will list any "SXF" files in the current
  298.       directory.  Selecting a file will load any non-existing
  299.       recipes into your database from the "SXF" file.  If the
  300.       recipe name already exists in your database, it will not be
  301.       replaced!  This is how the SUDS STARTUP recipes are
  302.       distributed (in file RECIPES.SXF).
  303.  
  304.       You are encouraged to share any "SXF" files you wish with
  305.       other users via BBS's, CompuServe or just among friends.
  306.       Please be sure to let users of your "SXF" files know that
  307.       SUDS or SUDSW is required to use the files.  Actually 
  308.       "SXF" does not use a complex file format at all, so non-SUDS
  309.       users could read the contents with any browse utility!
  310.  
  311.  
  312.  
  313.  
  314.                           Entering Log Entries
  315.  
  316.       Log entries can be entered into SUDSW only for recipes in
  317.       your SUDS database.  NOTE - If you wish to enter log entries
  318.       for recipes that you do not wish to enter into SUDSW, you
  319.       will have to create a "dummy" recipe.  To do this, just
  320.       create a recipe with no text, and give it a name when you
  321.       save it.
  322.  
  323.       To enter a log entry for a recipe, you must first open the
  324.       recipe file (see above).  When the desired recipe is
  325.       displayed, either click the right mouse button, or select
  326.       the Open Log option from the SUDSW File menu.  If any log
  327.       entries exist for this recipe, a list will be displayed
  328.       which allows you to select existing log entries or add new
  329.       ones.  If no log entries existed for the recipe, you are
  330.       taken directly to the log detail screen.
  331.  
  332.       The log detail screen contains a number of fields pertaining
  333.       to a particular batch of the selected recipe.  These
  334.       include: Date started, Date bottled, Starting and Finishing
  335.       gravities, Hop IBUs and free form notes.
  336.  
  337.       Here you fill in or update any information pertaining to
  338.       your recipe batch.  Several "shortcuts" or help functions
  339.       exist for these fields to assist you in entering.
  340.  
  341.       Date fields: pressing "+" or "-" in a date field will
  342.       increase or decrease the date by one day.  Pressing either
  343.       with a blank date will fill in the current date.  
  344.  
  345.       Hop IBUs: Pressing the right mouse button or selecting HOP
  346.       IBU Spreadsheet from the tools menu will bring up the HOP
  347.       IBU spreadsheet used to calculate HOP IBUs (International
  348.       Bittering units).  The Hop IBU spreadsheet allows you to
  349.       enter up to 4 different hop lines to calculate the IBU
  350.       value.
  351.  
  352.       Log Notes: The log notes field works exactly like the recipe
  353.       edit windows (see above).  The only difference is that the
  354.       tab key will jump you out of the log note field to the next
  355.       field.  This is where you will enter any comments about the
  356.       batch you are brewing.
  357.  
  358.       If no recipes are open when you select the Open Log option
  359.       from the SUDS File menu, you will get a chronological list
  360.       of all log entries in your database.  Here you can edit any
  361.       existing log entry.
  362.  
  363.  
  364.  
  365.  
  366.                  Printing Recipes, Log Entries or Labels
  367.  
  368.       Selecting Print from the SUDS File menu (or pressing Alt-P)
  369.       will bring up a print confirmation box for the current
  370.       recipe or log entry.
  371.  
  372.       For a log entry, selecting "Yes" or clicking on the Yes
  373.       button will print the current entry.
  374.  
  375.       For a recipe, 3 check boxes are displayed allowing you to
  376.       specify whether to print recipe text, stats and log entries
  377.       for the recipe.
  378.  
  379.       When a log entry is displayed, you can select print labels
  380.       from the SUDS tools menu.  This will display a sample label
  381.       that you can customize.  SUDS will print labels on standard
  382.       1-up mailing labels.  You can edit any of the information
  383.       shown on the sample label and can override the number of
  384.       labels to print.
  385.  
  386.  
  387.  
  388.  
  389.                    Appendix A - Technical information
  390.  
  391.       Suds was developed using Turbo-Pascal for Windows 1.5,
  392.       and Topaz database manager 3.5.
  393.  
  394.       The files used are standard DBASE-III+ compatible files.
  395.       However, the index files (*.IND) are not DBASE compatible.
  396.       If you intend to use DBASE against the files, you will have
  397.       to index the files yourself.  You should periodically select
  398.       the Pack option from the SUDS Options menu to optimize
  399.       indexes and reclaim deleted space.
  400.  
  401.       A non-Windows version of SUDS is also available and is 
  402.       functionally equivalent to the Windows version. 
  403.       The DOS version is called SUDS13.EXE or SUDS13.ZIP and is
  404.       available via the Compuserve Wine forum and various BBS's.
  405.  
  406.  
  407.  
  408.  
  409.                          SUDSW REGISTRATION FORM.
  410.  
  411.       NOTE - If you are already a registered user of SUDSW 1.0,
  412.       (meaning you've paid the fee already), this upgrade is 
  413.       FREE!  No upgrade fee is required.
  414.  
  415.         If you register before 12/31/93 and enclose one of your
  416.       own recipes to be included with future releases of SUDSW
  417.       (your name will also be included) you can register SUDSW for
  418.       $10 rather than the full price of $15.  Currently REGISTERED
  419.       users of DOS SUDS may upgrade to Windows version for $7.
  420.  
  421.  
  422.         Just copy this file to your printer, fold, and mail to
  423.  
  424.                                Michael Taylor
  425.                               1626 Main Street
  426.                          Bethlehem, PA  18018-1905
  427.  
  428.  
  429.          Enclosed please find $____ for the following:
  430.  
  431.                    [ ] $15 to register SUDSW 1.1
  432.  
  433.                    [ ] $10 to register SUDSW 1.1
  434.                        (I am enclosing recipe with order)
  435.                        $10 offer expires 12/31/93.
  436.  
  437.                    [ ] $7  to register SUDSW 1.1
  438.                        (Currently registered users of DOS SUDS only!)
  439.  
  440.  
  441.  
  442.             Name:________________________________________________
  443.          Address: _______________________________________________
  444.                   _______________________________________________
  445.            State: ___________________________ Zip:_______________
  446.  
  447.          SUDSW 1.1 was acquired from:
  448.  
  449.               [ ]  friend
  450.               [ ]  free BBS, name and phone #
  451.               [ ]  pay BBS (i.e., CompuServe)
  452.               [ ]  disk duplicating service, name
  453.               [ ]  user group
  454.               [ ]  other_________________________________________
  455.  
  456.          Comments, suggestions:
  457.  
  458.